/*
 * Copyright (c) 2009 Dan Broyles
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Dan Broyles <dbroyl01@ku.edu>
 * Thanks to Kevin Peters, faculty advisor James P.G. Sterbenz, and the ResiliNets
 * initiative at The University of Kansas, https://resilinets.org
 */
#ifndef GAUSS_MARKOV_MOBILITY_MODEL_H
#define GAUSS_MARKOV_MOBILITY_MODEL_H

#include "box.h"
#include "constant-velocity-helper.h"
#include "mobility-model.h"
#include "position-allocator.h"

#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/random-variable-stream.h"

namespace ns3
{

/**
 * @ingroup mobility
 * @brief Gauss-Markov mobility model
 *
 * This is a 3D version of the Gauss-Markov mobility model described in [1].
 * Unlike the other mobility models in ns-3, which are memoryless, the Gauss
 * Markov model has both memory and variability. The tunable alpha parameter
 * determines the how much memory and randomness you want to model.
 * Each object starts with a specific velocity, direction (radians), and pitch
 * angle (radians) equivalent to the mean velocity, direction, and pitch.
 * At each timestep, a new velocity, direction, and pitch angle are generated
 * based upon the previous value, the mean value, and a gaussian random variable.
 * This version is suited for simple airplane flight, where direction, velocity,
 * and pitch are the key variables.
 * The motion field is limited by a 3D bounding box (called "box") which is a 3D
 * version of the "rectangle" field that is used in 2-dimensional ns-3 mobility models.
 *
 * Here is an example of how to implement the model and set the initial node positions:
 * @code
    MobilityHelper mobility;

    mobility.SetMobilityModel ("ns3::GaussMarkovMobilityModel",
      "Bounds", BoxValue (Box (0, 150000, 0, 150000, 0, 10000)),
      "TimeStep", TimeValue (Seconds (0.5)),
      "Alpha", DoubleValue (0.85),
      "MeanVelocity", StringValue ("ns3::UniformRandomVariable[Min=800|Max=1200]"),
      "MeanDirection", StringValue ("ns3::UniformRandomVariable[Min=0|Max=6.283185307]"),
      "MeanPitch", StringValue ("ns3::UniformRandomVariable[Min=0.05|Max=0.05]"),
      "NormalVelocity", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.0|Bound=0.0]"),
      "NormalDirection", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.2|Bound=0.4]"),
      "NormalPitch", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.02|Bound=0.04]"));

    mobility.SetPositionAllocator ("ns3::RandomBoxPositionAllocator",
      "X", StringValue ("ns3::UniformRandomVariable[Min=0|Max=150000]"),
      "Y", StringValue ("ns3::UniformRandomVariable[Min=0|Max=150000]"),
      "Z", StringValue ("ns3::UniformRandomVariable[Min=0|Max=10000]"));

    mobility.Install (wifiStaNodes);
 * @endcode
 * [1] Tracy Camp, Jeff Boleng, Vanessa Davies, "A Survey of Mobility Models
 * for Ad Hoc Network Research", Wireless Communications and Mobile Computing,
 * Wiley, vol.2 iss.5, September 2002, pp.483-502
 */
class GaussMarkovMobilityModel : public MobilityModel
{
  public:
    /**
     * Register this type with the TypeId system.
     * @return the object TypeId
     */
    static TypeId GetTypeId();
    GaussMarkovMobilityModel();
    ~GaussMarkovMobilityModel() override;

  private:
    /**
     * Initialize the model and calculate new velocity, direction, and pitch
     */
    void Start();
    /**
     * Perform a walk operation
     * @param timeLeft time until Start method is called again
     */
    void DoWalk(Time timeLeft);
    void DoDispose() override;
    Vector DoGetPosition() const override;
    void DoSetPosition(const Vector& position) override;
    Vector DoGetVelocity() const override;
    int64_t DoAssignStreams(int64_t) override;
    ConstantVelocityHelper m_helper; //!< constant velocity helper
    Time m_timeStep;                 //!< duraiton after which direction and speed should change
    double m_alpha;                  //!< tunable constant in the model
    double m_meanVelocity;           //!< current mean velocity
    double m_meanDirection;          //!< current mean direction
    double m_meanPitch;              //!< current mean pitch
    double m_Velocity;               //!< current velocity
    double m_Direction;              //!< current direction
    double m_Pitch;                  //!< current pitch
    Ptr<RandomVariableStream> m_rndMeanVelocity;  //!< rv used to assign avg velocity
    Ptr<NormalRandomVariable> m_normalVelocity;   //!< Gaussian rv used to for next velocity
    Ptr<RandomVariableStream> m_rndMeanDirection; //!< rv used to assign avg direction
    Ptr<NormalRandomVariable> m_normalDirection;  //!< Gaussian rv for next direction value
    Ptr<RandomVariableStream> m_rndMeanPitch;     //!< rv used to assign avg. pitch
    Ptr<NormalRandomVariable> m_normalPitch;      //!< Gaussian rv for next pitch
    EventId m_event;                              //!< event id of scheduled start
    Box m_bounds;                                 //!< bounding box
};

} // namespace ns3

#endif /* GAUSS_MARKOV_MOBILITY_MODEL_H */
